Update to 1.3.0 to work in 2025 #4

BrandoDev · 2025-07-11T14:37:44Z

This pull request introduces several improvements and updates to the brawlpy library, focusing on improving usability, code readability, and functionality. The most significant changes include the addition of an asynchronous context manager for the Client class, refactoring of code for consistency and clarity, and updates to the README.md documentation.

Enhancements to `Client` functionality:

Added asynchronous context manager methods (__aenter__ and __aexit__) to the Client class, allowing the use of async with for managing the client session lifecycle. ([brawlpy/main.pyL4-R66](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-7cc0a1ecc2a1c7abbc754e5233bba68d768b7c92bacaa599c40be70f85c52b13L4-R66))
Refactored the request method in the Client class to handle session initialization errors and improve error handling. ([brawlpy/main.pyL4-R66](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-7cc0a1ecc2a1c7abbc754e5233bba68d768b7c92bacaa599c40be70f85c52b13L4-R66))
Updated various Client methods (get_player, get_club, brawlers, events, etc.) to use consistent string formatting and improved object creation for better readability. ([[1]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-7cc0a1ecc2a1c7abbc754e5233bba68d768b7c92bacaa599c40be70f85c52b13L40-R142), [[2]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-7cc0a1ecc2a1c7abbc754e5233bba68d768b7c92bacaa599c40be70f85c52b13L113-R206), [[3]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-7cc0a1ecc2a1c7abbc754e5233bba68d768b7c92bacaa599c40be70f85c52b13L143-R246), [[4]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-7cc0a1ecc2a1c7abbc754e5233bba68d768b7c92bacaa599c40be70f85c52b13L179-R284), [[5]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-7cc0a1ecc2a1c7abbc754e5233bba68d768b7c92bacaa599c40be70f85c52b13L211-R334), [[6]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-7cc0a1ecc2a1c7abbc754e5233bba68d768b7c92bacaa599c40be70f85c52b13L249-R377))

Documentation updates:

Updated the README.md to reflect the addition of the context manager for the Client class and corrected the installation command to point to the new repository URL. ([[1]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L12-R16), [[2]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L25-R25), [[3]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R37), [[4]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R55))

Codebase cleanup and consistency:

Replaced single quotes with double quotes across the codebase for consistency. ([[1]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-e5556f1147ae675e7061baebb2e7cddb9cc1d9006f03a765720373d6c3a2ab39L1-R3), [[2]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-2bf9fd80d007a3cb5d23139ad5bc9470436f2600e5389ca46ad74ac8cb11a833R20-R85), [[3]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-7cc0a1ecc2a1c7abbc754e5233bba68d768b7c92bacaa599c40be70f85c52b13L40-R142))
Refactored imports in brawlpy/__init__.py and brawlpy/main.py to explicitly list imported classes and objects, improving clarity and reducing wildcard imports. ([[1]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-d41c6849699852c678513a728c4873b8775605d8bdc527a3023671d786dad7fcL11-R47), [[2]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-7cc0a1ecc2a1c7abbc754e5233bba68d768b7c92bacaa599c40be70f85c52b13L4-R66))
Removed unused imports and redundant code in brawlpy/errors.py and other files. ([[1]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-2bf9fd80d007a3cb5d23139ad5bc9470436f2600e5389ca46ad74ac8cb11a833R10), [[2]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-7cc0a1ecc2a1c7abbc754e5233bba68d768b7c92bacaa599c40be70f85c52b13L4-R66))

Bug fixes and minor improvements:

Fixed a trailing comma issue in brawlpy/icons.py to adhere to JSON formatting standards. ([brawlpy/icons.pyL55-R55](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-fa51c3a021755e8ac61ec64529779176eb6aeb90b07ba5e2457167d09d129362L55-R55))
Improved error messages and handling in custom exceptions, ensuring better debugging information is provided. ([[1]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-2bf9fd80d007a3cb5d23139ad5bc9470436f2600e5389ca46ad74ac8cb11a833R20-R85), [[2]](https://github.com/PyStarr/BrawlPy/pull/4/files#diff-7cc0a1ecc2a1c7abbc754e5233bba68d768b7c92bacaa599c40be70f85c52b13L40-R142))

…ion if player hasnt any game history;

Copilot

Pull request overview

This pull request updates the brawlpy library to version 1.3.0 with improvements focused on modern async patterns, code formatting consistency, and documentation. The main enhancement is adding async context manager support to the Client class for better session lifecycle management.

Changes:

Added async context manager (__aenter__ and __aexit__) methods to Client class for proper session management
Standardized code formatting by replacing single quotes with double quotes and improving code consistency
Updated examples and README to demonstrate context manager usage

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
setup.py	Reformatted with double quotes and improved spacing consistency
examples/player.py	Updated to use async context manager pattern
examples/club.py	Updated to use async context manager pattern
brawlpy/utils.py	Improved formatting and updated imports
brawlpy/objects.py	Reformatted with consistent spacing and removed nameColor parameter from Player
brawlpy/main.py	Added context manager support, refactored session management, improved error handling
brawlpy/icons.py	Standardized dictionary formatting with double quotes
brawlpy/errors.py	Reformatted with double quotes for consistency
brawlpy/init.py	Replaced wildcard imports with explicit imports and updated version to 1.3.0
brawlpy/API.py	Removed unused imports and reformatted
README.md	Updated documentation to show context manager usage and corrected repository URL

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-18T15:47:22Z

brawlpy/main.py

+            Pl = Player(
+                player["name"],
+                player["tag"],
+                player["icon"]["id"],
+                player["trophies"],
+                player["expLevel"],
+                player["expPoints"],
+                cl,
+                player["highestTrophies"],
+                player["soloVictories"],
+                player["duoVictories"],
+                player["3vs3Victories"],
+                player["bestRoboRumbleTime"],
+                player["bestTimeAsBigBrawler"],
+                brrs,
+            )


The Player object instantiation is missing the battleLog parameter. The Player class constructor expects battleLog as the last parameter, but this code doesn't provide it. The old code had a call to get_battle_log that was removed but the parameter was never added here. This will cause a TypeError when creating a Player object.

Copilot · 2026-01-18T15:47:22Z

brawlpy/errors.py

    def __init__(self, url, code, text):
        self.code = code
        self.url = url
-        self.message = f'An unexpected error has occured.\n{text}'
+        self.message = f"An unexpected error has occured.\n{text}"
        super().__init__(self.code, self.message)


The UnexpectedError constructor signature has inconsistent parameter order. The init method defines parameters as (url, code, text), but all call sites in main.py pass them as (status, url, ""). This will cause url to be assigned to code and "" to be assigned to url, breaking error reporting.

Copilot · 2026-01-18T15:47:23Z

setup.py

+    url="https://github.com/PyStarr/BrawlPy",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    download_url="https://github.com/PyStarr/BrawlPy/archive/v1.2.5.tar.gz",


The download_url still references version "1.2.5" in the archive URL, but should be updated to "1.3.0" to match the new version number.

@copilot open a new pull request to apply changes based on this feedback

examples/player.py

Copilot · 2026-01-18T15:47:23Z

brawlpy/errors.py


+
 class UnexpectedError(Errors):
    """Raised if an unknown error has occured."""


Spelling error: "occured" should be "occurred" (double 'r').

Copilot · 2026-01-18T15:47:24Z

brawlpy/main.py

+                rankgs.append(
+                    BrawlerRanking(
+                        "",
+                        each["tag"],
+                        each["name"],
+                        each["nameColor"],
+                        each["icon"]["id"],
+                        each["trophies"],
+                        each["rank"],
+                        cl,
+                    )
+                )


The BrawlerRanking constructor is being called with an empty string as the first parameter for 'brawler'. According to the BrawlerRanking class definition, the first parameter should be the brawler name or identifier, not an empty string. The API response should contain brawler information that needs to be extracted and passed here.

Copilot · 2026-01-18T15:47:24Z

brawlpy/errors.py

-    def __init__(self,code,countryCode = None):
+    def __init__(self, code, countryCode=None):
        self.code = code
        if id:


The condition uses 'id' instead of 'countryCode'. This is a copy-paste error from the BrawlerNotFound exception above. It should check 'if countryCode:' to properly set the error message.

Suggested change

if id:

if countryCode:

Copilot · 2026-01-18T15:47:24Z

brawlpy/errors.py

+    def __init__(self, code, id=None):
        self.code = code
        if id:
-            self.message = 'Invalid ID passed! {}'.format(id)
+            self.message = "Invalid ID passed! {}".format(id)

        super().__init__(self.code, self.message)


The BrawlerNotFound exception doesn't initialize self.message when id is None or falsy. This will cause an AttributeError when the exception is raised without an id parameter, since str tries to access self.message.

Copilot · 2026-01-18T15:47:24Z

setup.py

-)
+    name="brawlpy",
+    packages=["brawlpy"],
+    version="1.2.5",


The version number in setup.py is still "1.2.5" but the PR title mentions updating to "1.3.0" and version in init.py has been updated to "1.3.0". These should be consistent.

Copilot · 2026-01-18T15:47:25Z

brawlpy/errors.py

        self.code = code
        self.url = url
-        self.message = f'An unexpected error has occured.\n{text}'
+        self.message = f"An unexpected error has occured.\n{text}"


Spelling error: "occured" should be "occurred" (double 'r').

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…mplementation

BrandoDev added 9 commits May 19, 2025 19:03

get_player fixed

b6db15c

added context manager support;

967e402

updated examples for context manager

652d82e

updated version to 1.3.0

02e3e15

allowed_chars fix

e17e33d

allowed chars was right before: hotfix

a279e5b

ruff format

cb3dfee

refactor: clean up imports and update installation command in README

12cf9a2

project is now conform to ruff linter and ty type checker

5840ce6

BrandoDev marked this pull request as ready for review July 11, 2025 14:38

removed get battle log from get player; useless, and can raise except…

73e6ac8

…ion if player hasnt any game history;

Copilot AI review requested due to automatic review settings January 18, 2026 15:43

Copilot started reviewing on behalf of BrandoDev January 18, 2026 15:43 View session

Copilot AI reviewed Jan 18, 2026

View reviewed changes

BrandoDev and others added 2 commits January 18, 2026 17:57

Update examples/player.py

0893c1d

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

remove battleLog attribute from Player class; not needed in current i…

b230077

…mplementation

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update to 1.3.0 to work in 2025 #4

Update to 1.3.0 to work in 2025 #4

Uh oh!

BrandoDev commented Jul 11, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 18, 2026

Uh oh!

Copilot AI Jan 18, 2026

Uh oh!

Copilot AI Jan 18, 2026

Uh oh!

BrandoDev Jan 18, 2026

Uh oh!

Uh oh!

Copilot AI Jan 18, 2026

Uh oh!

Copilot AI Jan 18, 2026

Uh oh!

Copilot AI Jan 18, 2026

Uh oh!

Copilot AI Jan 18, 2026

Uh oh!

Copilot AI Jan 18, 2026

Uh oh!

Copilot AI Jan 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant



		class UnexpectedError(Errors):
		"""Raised if an unknown error has occured."""

Update to 1.3.0 to work in 2025 #4

Are you sure you want to change the base?

Update to 1.3.0 to work in 2025 #4

Uh oh!

Conversation

BrandoDev commented Jul 11, 2025

Enhancements to Client functionality:

Documentation updates:

Codebase cleanup and consistency:

Bug fixes and minor improvements:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

BrandoDev Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Enhancements to `Client` functionality: